home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / info / texinfo.info-11.z / texinfo.info-11
Encoding:
GNU Info File  |  1998-05-21  |  38.8 KB  |  850 lines

  1. This is Info file ../info/texinfo.info, produced by Makeinfo version
  2. 1.68 from the input file texinfo.texi.
  3.  
  4. INFO-DIR-SECTION Texinfo documentation system
  5. START-INFO-DIR-ENTRY
  6. * Texinfo: (texinfo).           The GNU documentation format.
  7. * install-info: (texinfo)Invoking install-info. Updating info/dir entries.
  8. * texi2dvi: (texinfo)Format with texi2dvi.      Printing Texinfo documentation.
  9. * texindex: (texinfo)Format with tex/texindex.  Sorting Texinfo index files.
  10. * makeinfo: (texinfo)makeinfo Preferred.        Translate Texinfo source.
  11. END-INFO-DIR-ENTRY
  12.  
  13.   This file documents Texinfo, a documentation system that can produce
  14. both on-line information and a printed manual from a single source file.
  15.  
  16.   Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97 Free Software
  17. Foundation, Inc.
  18.  
  19.   This is the second edition of the Texinfo documentation,
  20. and is consistent with version 2 of `texinfo.tex'.
  21.  
  22.   Permission is granted to make and distribute verbatim copies of this
  23. manual provided the copyright notice and this permission notice are
  24. preserved on all copies.
  25.  
  26.   Permission is granted to copy and distribute modified versions of this
  27. manual under the conditions for verbatim copying, provided that the
  28. entire resulting derived work is distributed under the terms of a
  29. permission notice identical to this one.
  30.  
  31.   Permission is granted to copy and distribute translations of this
  32. manual into another language, under the above conditions for modified
  33. versions, except that this permission notice may be stated in a
  34. translation approved by the Free Software Foundation.
  35.  
  36. 
  37. File: texinfo.info,  Node: Debugging with TeX,  Next: Using texinfo-show-structure,  Prev: Debugging with Info,  Up: Catching Mistakes
  38.  
  39. Catching Errors with TeX Formatting
  40. ===================================
  41.  
  42.   You can also catch mistakes when you format a file with TeX.
  43.  
  44.   Usually, you will want to do this after you have run
  45. `texinfo-format-buffer' (or, better, `makeinfo-buffer') on the same
  46. file, because `texinfo-format-buffer' sometimes displays error messages
  47. that make more sense than TeX.  (*Note Debugging with Info::, for more
  48. information.)
  49.  
  50.   For example, TeX was run on a Texinfo file, part of which is shown
  51. here:
  52.  
  53.      ---------- Buffer: texinfo.texi ----------
  54.      name of the Texinfo file as an extension.  The
  55.      @samp{??} are `wildcards' that cause the shell to
  56.      substitute all the raw index files.  (@xref{sorting
  57.      indices, for more information about sorting
  58.      indices.)@refill
  59.      ---------- Buffer: texinfo.texi ----------
  60.  
  61. (The cross reference lacks a closing brace.)  TeX produced the
  62. following output, after which it stopped:
  63.  
  64.      ---------- Buffer: *tex-shell* ----------
  65.      Runaway argument?
  66.      {sorting indices, for more information about sorting
  67.      indices.) @refill @ETC.
  68.      ! Paragraph ended before @xref was complete.
  69.      <to be read again>
  70.                         @par
  71.      l.27
  72.      
  73.      ?
  74.      ---------- Buffer: *tex-shell* ----------
  75.  
  76.   In this case, TeX produced an accurate and understandable error
  77. message:
  78.  
  79.      Paragraph ended before @xref was complete.
  80.  
  81. `@par' is an internal TeX command of no relevance to Texinfo.  `l.27'
  82. means that TeX detected the problem on line 27 of the Texinfo file.
  83. The `?' is the prompt TeX uses in this circumstance.
  84.  
  85.   Unfortunately, TeX is not always so helpful, and sometimes you must
  86. truly be a Sherlock Holmes to discover what went wrong.
  87.  
  88.   In any case, if you run into a problem like this, you can do one of
  89. three things.
  90.  
  91.   1. You can tell TeX to continue running and ignore just this error by
  92.      typing <RET> at the `?' prompt.
  93.  
  94.   2. You can tell TeX to continue running and to ignore all errors as
  95.      best it can by typing `r <RET>' at the `?' prompt.
  96.  
  97.      This is often the best thing to do.  However, beware: the one error
  98.      may produce a cascade of additional error messages as its
  99.      consequences are felt through the rest of the file.  To stop TeX
  100.      when it is producing such an avalanche of error messages, type
  101.      `C-c' (or `C-c C-c', if you are running a shell inside Emacs).
  102.  
  103.   3. You can tell TeX to stop this run by typing `x <RET>' at the `?'
  104.      prompt.
  105.  
  106.   Please note that if you are running TeX inside Emacs, you need to
  107. switch to the shell buffer and line at which TeX offers the `?'  prompt.
  108.  
  109.   Sometimes TeX will format a file without producing error messages even
  110. though there is a problem.  This usually occurs if a command is not
  111. ended but TeX is able to continue processing anyhow.  For example, if
  112. you fail to end an itemized list with the `@end itemize' command, TeX
  113. will write a DVI file that you can print out.  The only error message
  114. that TeX will give you is the somewhat mysterious comment that
  115.  
  116.      (@end occurred inside a group at level 1)
  117.  
  118. However, if you print the DVI file, you will find that the text of the
  119. file that follows the itemized list is entirely indented as if it were
  120. part of the last item in the itemized list.  The error message is the
  121. way TeX says that it expected to find an `@end' command somewhere in
  122. the file; but that it could not determine where it was needed.
  123.  
  124.   Another source of notoriously hard-to-find errors is a missing `@end
  125. group' command.  If you ever are stumped by incomprehensible errors,
  126. look for a missing `@end group' command first.
  127.  
  128.   If the Texinfo file lacks header lines, TeX may stop in the beginning
  129. of its run and display output that looks like the following.  The `*'
  130. indicates that TeX is waiting for input.
  131.  
  132.      This is TeX, Version 3.14159 (Web2c 7.0)
  133.      (test.texinfo [1])
  134.      *
  135.  
  136. In this case, simply type `\end <RET>' after the asterisk.  Then write
  137. the header lines in the Texinfo file and run the TeX command again.
  138. (Note the use of the backslash, `\'.  TeX uses `\' instead of `@'; and
  139. in this circumstance, you are working directly with TeX, not with
  140. Texinfo.)
  141.  
  142. 
  143. File: texinfo.info,  Node: Using texinfo-show-structure,  Next: Using occur,  Prev: Debugging with TeX,  Up: Catching Mistakes
  144.  
  145. Using `texinfo-show-structure'
  146. ==============================
  147.  
  148.   It is not always easy to keep track of the nodes, chapters, sections,
  149. and subsections of a Texinfo file.  This is especially true if you are
  150. revising or adding to a Texinfo file that someone else has written.
  151.  
  152.   In GNU Emacs, in Texinfo mode, the `texinfo-show-structure' command
  153. lists all the lines that begin with the @-commands that specify the
  154. structure: `@chapter', `@section', `@appendix', and so on.  With an
  155. argument (`C-u' as prefix argument, if interactive), the command also
  156. shows the `@node' lines.  The `texinfo-show-structure' command is bound
  157. to `C-c C-s' in Texinfo mode, by default.
  158.  
  159.   The lines are displayed in a buffer called the `*Occur*' buffer,
  160. indented by hierarchical level.  For example, here is a part of what was
  161. produced by running `texinfo-show-structure' on this manual:
  162.  
  163.       Lines matching "^@\\(chapter \\|sect\\|subs\\|subh\\|
  164.       unnum\\|major\\|chapheading \\|heading \\|appendix\\)"
  165.       in buffer texinfo.texi.
  166.       ...
  167.       4177:@chapter Nodes
  168.       4198:    @heading Two Paths
  169.       4231:    @section Node and Menu Illustration
  170.       4337:    @section The @code{@@node} Command
  171.       4393:        @subheading Choosing Node and Pointer Names
  172.       4417:        @subsection How to Write an @code{@@node} Line
  173.       4469:        @subsection @code{@@node} Line Tips
  174.       ...
  175.  
  176.   This says that lines 4337, 4393, and 4417 of `texinfo.texi' begin
  177. with the `@section', `@subheading', and `@subsection' commands
  178. respectively.  If you move your cursor into the `*Occur*' window, you
  179. can position the cursor over one of the lines and use the `C-c C-c'
  180. command (`occur-mode-goto-occurrence'), to jump to the corresponding
  181. spot in the Texinfo file.  *Note Using Occur: (emacs)Other Repeating
  182. Search, for more information about `occur-mode-goto-occurrence'.
  183.  
  184.   The first line in the `*Occur*' window describes the "regular
  185. expression" specified by TEXINFO-HEADING-PATTERN.  This regular
  186. expression is the pattern that `texinfo-show-structure' looks for.
  187. *Note Using Regular Expressions: (emacs)Regexps, for more information.
  188.  
  189.   When you invoke the `texinfo-show-structure' command, Emacs will
  190. display the structure of the whole buffer.  If you want to see the
  191. structure of just a part of the buffer, of one chapter, for example,
  192. use the `C-x n n' (`narrow-to-region') command to mark the region.
  193. (*Note Narrowing: (emacs)Narrowing.)  This is how the example used
  194. above was generated.  (To see the whole buffer again, use `C-x n w'
  195. (`widen').)
  196.  
  197.   If you call `texinfo-show-structure' with a prefix argument by typing
  198. `C-u C-c C-s', it will list lines beginning with `@node' as well as the
  199. lines beginning with the @-sign commands for `@chapter', `@section',
  200. and the like.
  201.  
  202.   You can remind yourself of the structure of a Texinfo file by looking
  203. at the list in the `*Occur*' window; and if you have mis-named a node
  204. or left out a section, you can correct the mistake.
  205.  
  206. 
  207. File: texinfo.info,  Node: Using occur,  Next: Running Info-Validate,  Prev: Using texinfo-show-structure,  Up: Catching Mistakes
  208.  
  209. Using `occur'
  210. =============
  211.  
  212.   Sometimes the `texinfo-show-structure' command produces too much
  213. information.  Perhaps you want to remind yourself of the overall
  214. structure of a Texinfo file, and are overwhelmed by the detailed list
  215. produced by `texinfo-show-structure'.  In this case, you can use the
  216. `occur' command directly.  To do this, type
  217.  
  218.      M-x occur
  219.  
  220. and then, when prompted, type a "regexp", a regular expression for the
  221. pattern you want to match.  (*Note Regular Expressions:
  222. (emacs)Regexps.)  The `occur' command works from the current location
  223. of the cursor in the buffer to the end of the buffer.  If you want to
  224. run `occur' on the whole buffer, place the cursor at the beginning of
  225. the buffer.
  226.  
  227.   For example, to see all the lines that contain the word `@chapter' in
  228. them, just type `@chapter'.  This will produce a list of the chapters.
  229. It will also list all the sentences with `@chapter' in the middle of
  230. the line.
  231.  
  232.   If you want to see only those lines that start with the word
  233. `@chapter', type `^@chapter' when prompted by `occur'.  If you want to
  234. see all the lines that end with a word or phrase, end the last word
  235. with a `$'; for example, `catching mistakes$'.  This can be helpful
  236. when you want to see all the nodes that are part of the same chapter or
  237. section and therefore have the same `Up' pointer.
  238.  
  239.   *Note Using Occur: (emacs)Other Repeating Search, for more
  240. information.
  241.  
  242. 
  243. File: texinfo.info,  Node: Running Info-Validate,  Prev: Using occur,  Up: Catching Mistakes
  244.  
  245. Finding Badly Referenced Nodes
  246. ==============================
  247.  
  248.   You can use the `Info-validate' command to check whether any of the
  249. `Next', `Previous', `Up' or other node pointers fail to point to a
  250. node.  This command checks that every node pointer points to an
  251. existing node.  The `Info-validate' command works only on Info files,
  252. not on Texinfo files.
  253.  
  254.   The `makeinfo' program validates pointers automatically, so you do
  255. not need to use the `Info-validate' command if you are using
  256. `makeinfo'.  You only may need to use `Info-validate' if you are unable
  257. to run `makeinfo' and instead must create an Info file using
  258. `texinfo-format-region' or `texinfo-format-buffer', or if you write an
  259. Info file from scratch.
  260.  
  261. * Menu:
  262.  
  263. * Using Info-validate::         How to run `Info-validate'.
  264. * Unsplit::                     How to create an unsplit file.
  265. * Tagifying::                   How to tagify a file.
  266. * Splitting::                   How to split a file manually.
  267.  
  268. 
  269. File: texinfo.info,  Node: Using Info-validate,  Next: Unsplit,  Prev: Running Info-Validate,  Up: Running Info-Validate
  270.  
  271. Running `Info-validate'
  272. -----------------------
  273.  
  274.   To use `Info-validate', visit the Info file you wish to check and
  275. type:
  276.  
  277.      M-x Info-validate
  278.  
  279. (Note that the `Info-validate' command requires an upper case `I'.  You
  280. may also need to create a tag table before running `Info-validate'.
  281. *Note Tagifying::.)
  282.  
  283.   If your file is valid, you will receive a message that says "File
  284. appears valid".  However, if you have a pointer that does not point to
  285. a node, error messages will be displayed in a buffer called `*problems
  286. in info file*'.
  287.  
  288.   For example, `Info-validate' was run on a test file that contained
  289. only the first node of this manual.  One of the messages said:
  290.  
  291.      In node "Overview", invalid Next: Texinfo Mode
  292.  
  293. This meant that the node called `Overview' had a `Next' pointer that
  294. did not point to anything (which was true in this case, since the test
  295. file had only one node in it).
  296.  
  297.   Now suppose we add a node named `Texinfo Mode' to our test case but
  298. we do not specify a `Previous' for this node.  Then we will get the
  299. following error message:
  300.  
  301.      In node "Texinfo Mode", should have Previous: Overview
  302.  
  303. This is because every `Next' pointer should be matched by a `Previous'
  304. (in the node where the `Next' points) which points back.
  305.  
  306.   `Info-validate' also checks that all menu entries and cross references
  307. point to actual nodes.
  308.  
  309.   Note that `Info-validate' requires a tag table and does not work with
  310. files that have been split.  (The `texinfo-format-buffer' command
  311. automatically splits large files.)  In order to use `Info-validate' on
  312. a large file, you must run `texinfo-format-buffer' with an argument so
  313. that it does not split the Info file; and you must create a tag table
  314. for the unsplit file.
  315.  
  316. 
  317. File: texinfo.info,  Node: Unsplit,  Next: Tagifying,  Prev: Using Info-validate,  Up: Running Info-Validate
  318.  
  319. Creating an Unsplit File
  320. ------------------------
  321.  
  322.   You can run `Info-validate' only on a single Info file that has a tag
  323. table.  The command will not work on the indirect subfiles that are
  324. generated when a master file is split.  If you have a large file
  325. (longer than 70,000 bytes or so), you need to run the
  326. `texinfo-format-buffer' or `makeinfo-buffer' command in such a way that
  327. it does not create indirect subfiles.  You will also need to create a
  328. tag table for the Info file.  After you have done this, you can run
  329. `Info-validate' and look for badly referenced nodes.
  330.  
  331.   The first step is to create an unsplit Info file.  To prevent
  332. `texinfo-format-buffer' from splitting a Texinfo file into smaller Info
  333. files, give a prefix to the `M-x texinfo-format-buffer' command:
  334.  
  335.      C-u M-x texinfo-format-buffer
  336.  
  337. or else
  338.  
  339.      C-u C-c C-e C-b
  340.  
  341. When you do this, Texinfo will not split the file and will not create a
  342. tag table for it.
  343.  
  344. 
  345. File: texinfo.info,  Node: Tagifying,  Next: Splitting,  Prev: Unsplit,  Up: Running Info-Validate
  346.  
  347. Tagifying a File
  348. ----------------
  349.  
  350.   After creating an unsplit Info file, you must create a tag table for
  351. it.  Visit the Info file you wish to tagify and type:
  352.  
  353.      M-x Info-tagify
  354.  
  355. (Note the upper case `I' in `Info-tagify'.)  This creates an Info file
  356. with a tag table that you can validate.
  357.  
  358.   The third step is to validate the Info file:
  359.  
  360.      M-x Info-validate
  361.  
  362. (Note the upper case `I' in `Info-validate'.)  In brief, the steps are:
  363.  
  364.      C-u M-x texinfo-format-buffer
  365.      M-x Info-tagify
  366.      M-x Info-validate
  367.  
  368.   After you have validated the node structure, you can rerun
  369. `texinfo-format-buffer' in the normal way so it will construct a tag
  370. table and split the file automatically, or you can make the tag table
  371. and split the file manually.
  372.  
  373. 
  374. File: texinfo.info,  Node: Splitting,  Prev: Tagifying,  Up: Running Info-Validate
  375.  
  376. Splitting a File Manually
  377. -------------------------
  378.  
  379.   You should split a large file or else let the `texinfo-format-buffer'
  380. or `makeinfo-buffer' command do it for you automatically.  (Generally
  381. you will let one of the formatting commands do this job for you.  *Note
  382. Create an Info File::.)
  383.  
  384.   The split-off files are called the indirect subfiles.
  385.  
  386.   Info files are split to save memory.  With smaller files, Emacs does
  387. not have make such a large buffer to hold the information.
  388.  
  389.   If an Info file has more than 30 nodes, you should also make a tag
  390. table for it. *Note Using Info-validate::, for information about
  391. creating a tag table.  (Again, tag tables are usually created
  392. automatically by the formatting command; you only need to create a tag
  393. table yourself if you are doing the job manually.  Most likely, you
  394. will do this for a large, unsplit file on which you have run
  395. `Info-validate'.)
  396.  
  397.   Visit the Info file you wish to tagify and split and type the two
  398. commands:
  399.  
  400.      M-x Info-tagify
  401.      M-x Info-split
  402.  
  403. (Note that the `I' in `Info' is upper case.)
  404.  
  405.   When you use the `Info-split' command, the buffer is modified into a
  406. (small) Info file which lists the indirect subfiles.  This file should
  407. be saved in place of the original visited file.  The indirect subfiles
  408. are written in the same directory the original file is in, with names
  409. generated by appending `-' and a number to the original file name.
  410.  
  411.   The primary file still functions as an Info file, but it contains just
  412. the tag table and a directory of subfiles.
  413.  
  414. 
  415. File: texinfo.info,  Node: Refilling Paragraphs,  Next: Command Syntax,  Prev: Catching Mistakes,  Up: Top
  416.  
  417. Refilling Paragraphs
  418. ********************
  419.  
  420.   The `@refill' command refills and, optionally, indents the first line
  421. of a paragraph.(1) (*note Refilling Paragraphs-Footnotes::) The
  422. `@refill' command is no longer important, but we describe it here
  423. because you once needed it.  You will see it in many old Texinfo files.
  424.  
  425.   Without refilling, paragraphs containing long @-constructs may look
  426. bad after formatting because the formatter removes @-commands and
  427. shortens some lines more than others.  In the past, neither the
  428. `texinfo-format-region' command nor the `texinfo-format-buffer' command
  429. refilled paragraphs automatically.  The `@refill' command had to be
  430. written at the end of every paragraph to cause these formatters to fill
  431. them.  (Both TeX and `makeinfo' have always refilled paragraphs
  432. automatically.)  Now, all the Info formatters automatically fill and
  433. indent those paragraphs that need to be filled and indented.
  434.  
  435.   The `@refill' command causes `texinfo-format-region' and
  436. `texinfo-format-buffer' to refill a paragraph in the Info file *after*
  437. all the other processing has been done.  For this reason, you can not
  438. use `@refill' with a paragraph containing either `@*' or `@w{ ... }'
  439. since the refilling action will override those two commands.
  440.  
  441.   The `texinfo-format-region' and `texinfo-format-buffer' commands now
  442. automatically append `@refill' to the end of each paragraph that should
  443. be filled.  They do not append `@refill' to the ends of paragraphs that
  444. contain `@*' or `@w{ ...}' and therefore do not refill or indent them.
  445.  
  446. 
  447. File: texinfo.info,  Node: Refilling Paragraphs-Footnotes,  Up: Refilling Paragraphs
  448.  
  449.   (1) Perhaps the command should have been called the
  450. `@refillandindent' command, but `@refill' is shorter and the name was
  451. chosen before indenting was possible.
  452.  
  453. 
  454. File: texinfo.info,  Node: Command Syntax,  Next: Obtaining TeX,  Prev: Refilling Paragraphs,  Up: Top
  455.  
  456. @-Command Syntax
  457. ****************
  458.  
  459.   The character `@' is used to start special Texinfo commands.  (It has
  460. the same meaning that `\' has in plain TeX.)  Texinfo has four types of
  461. @-command:
  462.  
  463. 1. Non-alphabetic commands.
  464.      These commands consist of an @ followed by a punctuation mark or
  465.      other character that is not part of the alphabet.  Non-alphabetic
  466.      commands are almost always part of the text within a paragraph,
  467.      and never take any argument.  The two characters (@ and the other
  468.      one) are complete in themselves; none is followed by braces.  The
  469.      non-alphabetic commands are: `@.', `@:', `@*', `@SPACE', `@TAB',
  470.      `@NL', `@@', `@{', and `@}'.
  471.  
  472. 2. Alphabetic commands that do not require arguments.
  473.      These commands start with @ followed by a word followed by left-
  474.      and right-hand braces.  These commands insert special symbols in
  475.      the document; they do not require arguments.  For example,
  476.      `@dots{}' => `...', `@equiv{}' => `==', `@TeX{}' => `TeX', and
  477.      `@bullet{}' => `*'.
  478.  
  479. 3. Alphabetic commands that require arguments within braces.
  480.      These commands start with @ followed by a letter or a word,
  481.      followed by an argument within braces.  For example, the command
  482.      `@dfn' indicates the introductory or defining use of a term; it is
  483.      used as follows: `In Texinfo, @@-commands are @dfn{mark-up}
  484.      commands.'
  485.  
  486. 4. Alphabetic commands that occupy an entire line.
  487.      These commands occupy an entire line.  The line starts with @,
  488.      followed by the name of the command (a word); for example,
  489.      `@center' or `@cindex'.  If no argument is needed, the word is
  490.      followed by the end of the line.  If there is an argument, it is
  491.      separated from the command name by a space.  Braces are not used.
  492.  
  493.   Thus, the alphabetic commands fall into classes that have different
  494. argument syntaxes.  You cannot tell to which class a command belongs by
  495. the appearance of its name, but you can tell by the command's meaning:
  496. if the command stands for a glyph, it is in class 2 and does not
  497. require an argument; if it makes sense to use the command together with
  498. other text as part of a paragraph, the command is in class 3 and must
  499. be followed by an argument in braces; otherwise, it is in class 4 and
  500. uses the rest of the line as its argument.
  501.  
  502.   The purpose of having a different syntax for commands of classes 3 and
  503. 4 is to make Texinfo files easier to read, and also to help the GNU
  504. Emacs paragraph and filling commands work properly.  There is only one
  505. exception to this rule: the command `@refill', which is always used at
  506. the end of a paragraph immediately following the final period or other
  507. punctuation character.  `@refill' takes no argument and does *not*
  508. require braces.  `@refill' never confuses the Emacs paragraph commands
  509. because it cannot appear at the beginning of a line.
  510.  
  511. 
  512. File: texinfo.info,  Node: Obtaining TeX,  Next: Command and Variable Index,  Prev: Command Syntax,  Up: Top
  513.  
  514. How to Obtain TeX
  515. *****************
  516.  
  517.   TeX is freely redistributable.  You can obtain TeX for Unix systems
  518. via anonymous ftp or on physical media.  The core material consists of
  519. the Web2c TeX distribution (`http://www.tug.org/web2c').
  520.  
  521.   Instructions for retrieval by anonymous ftp and information on other
  522. available distributions:
  523.      `ftp://ftp.tug.org/tex/unixtex.ftp'
  524.      `http://www.tug.org/unixtex.ftp'
  525.  
  526.   The Free Software Foundation provides a core distribution on its
  527. Source Code CD-ROM suitable for printing Texinfo manuals; the
  528. University of Washington maintains and supports a tape distribution;
  529. the TeX Users Group co-sponsors a complete CD-ROM TeX distribution.
  530.  
  531.    * For the FSF Source Code CD-ROM, please contact:
  532.  
  533.           Free Software Foundation, Inc.
  534.           59 Temple Place Suite 330
  535.           Boston, MA   02111-1307
  536.           USA
  537.           
  538.           Telephone: +1-617-542-5942
  539.           Fax: (including Japan) +1-617-542-2652
  540.           Free Dial Fax (in Japan):
  541.                 0031-13-2473 (KDD)
  542.                 0066-3382-0158 (IDC)
  543.           Electronic mail: `gnu@prep.ai.mit.edu'
  544.  
  545.    * To order a complete distribution on CD-ROM, please see
  546.      `http://www.tug.org/tex-live.html'.  (This distribution is also
  547.      available by FTP; see the URL's above.)
  548.  
  549.    * To order a full distribution from the University of Washington on
  550.      either a 1/4in 4-track QIC-24 cartridge or a 4mm DAT cartridge,
  551.      send $210 to:
  552.  
  553.           Pierre A. MacKay
  554.           Denny Hall, Mail Stop DH-10
  555.           University of Washington
  556.           Seattle, WA   98195
  557.           USA
  558.           Telephone: +1--206--543--2268
  559.           Electronic mail: `mackay@cs.washington.edu'
  560.  
  561.      Please make checks payable to the University of Washington.
  562.      Checks must be in U.S. dollars, drawn on a U.S. bank.  Overseas
  563.      sites: please add to the base cost, if desired, $20.00 for
  564.      shipment via air parcel post, or $30.00 for shipment via courier.
  565.  
  566.   Many other TeX distributions are available; see `http://www.tug.org/'.
  567.  
  568. 
  569. File: texinfo.info,  Node: Command and Variable Index,  Next: Concept Index,  Prev: Obtaining TeX,  Up: Top
  570.  
  571. Command and Variable Index
  572. **************************
  573.  
  574.   This is an alphabetical list of all the @-commands, assorted Emacs
  575. Lisp functions, and several variables.  To make the list easier to use,
  576. the commands are listed without their preceding `@'.
  577.  
  578. * Menu:
  579.  
  580. * ! (end of sentence):                   Ending a Sentence.
  581. * ":                                     Inserting Accents.
  582. * ':                                     Inserting Accents.
  583. * (newline):                             Multiple Spaces.
  584. * (space):                               Multiple Spaces.
  585. * (tab):                                 Multiple Spaces.
  586. * * (force line break):                  Line Breaks.
  587. * ,:                                     Inserting Accents.
  588. * -:                                     - and hyphenation.
  589. * .  (end of sentence):                  Ending a Sentence.
  590. * : (suppress widening):                 Not Ending a Sentence.
  591. * =:                                     Inserting Accents.
  592. * ? (end of sentence):                   Ending a Sentence.
  593. * @ (single @):                          Inserting An Atsign.
  594. * ^:                                     Inserting Accents.
  595. * `:                                     Inserting Accents.
  596. * AA:                                    Inserting Accents.
  597. * aa:                                    Inserting Accents.
  598. * AE:                                    Inserting Accents.
  599. * ae:                                    Inserting Accents.
  600. * afourpaper:                            A4 Paper.
  601. * appendix:                              unnumbered & appendix.
  602. * appendixsec:                           unnumberedsec appendixsec heading.
  603. * appendixsection:                       unnumberedsec appendixsec heading.
  604. * appendixsubsec:                        unnumberedsubsec appendixsubsec subheading.
  605. * appendixsubsubsec:                     subsubsection.
  606. * apply:                                 Sample Function Definition.
  607. * asis:                                  table.
  608. * author:                                title subtitle author.
  609. * b (bold font):                         Fonts.
  610. * buffer-end:                            Def Cmd Template.
  611. * bullet:                                bullet.
  612. * bye <1>:                               File End.
  613. * bye:                                   Ending a File.
  614. * c (comment):                           Comments.
  615. * cartouche:                             cartouche.
  616. * center:                                titlefont center sp.
  617. * centerchap:                            chapter.
  618. * chapheading:                           majorheading & chapheading.
  619. * chapter:                               chapter.
  620. * cindex:                                Indexing Commands.
  621. * cite:                                  cite.
  622. * clear:                                 ifset ifclear.
  623. * code:                                  code.
  624. * columnfractions:                       Multitable Column Widths.
  625. * comment:                               Comments.
  626. * contents:                              Contents.
  627. * copyright <1>:                         copyright symbol.
  628. * copyright:                             Copyright & Permissions.
  629. * cropmarks:                             Cropmarks and Magnification.
  630. * defcodeindex:                          New Indices.
  631. * defcv:                                 Abstract Objects.
  632. * deffn:                                 Functions Commands.
  633. * deffnx:                                deffnx.
  634. * defindex:                              New Indices.
  635. * definfoenclose:                        Customized Highlighting.
  636. * defivar:                               Abstract Objects.
  637. * defmac:                                Functions Commands.
  638. * defmethod:                             Abstract Objects.
  639. * defop:                                 Abstract Objects.
  640. * defopt:                                Variables Commands.
  641. * defspec:                               Functions Commands.
  642. * deftp:                                 Data Types.
  643. * deftypefn:                             Typed Functions.
  644. * deftypefun:                            Typed Functions.
  645. * deftypevar:                            Typed Variables.
  646. * deftypevr:                             Typed Variables.
  647. * defun:                                 Functions Commands.
  648. * defvar:                                Variables Commands.
  649. * defvr:                                 Variables Commands.
  650. * dfn:                                   dfn.
  651. * dircategory:                           Installing Dir Entries.
  652. * direntry:                              Installing Dir Entries.
  653. * display:                               display.
  654. * dmn:                                   dmn.
  655. * dotaccent:                             Inserting Accents.
  656. * dotless:                               Inserting Accents.
  657. * dots:                                  dots.
  658. * email:                                 email.
  659. * emph:                                  emph & strong.
  660. * end <1>:                               Introducing Lists.
  661. * end:                                   Quotations and Examples.
  662. * end titlepage:                         end titlepage.
  663. * enumerate:                             enumerate.
  664. * evenfooting:                           Custom Headings.
  665. * evenheading:                           Custom Headings.
  666. * everyfooting:                          Custom Headings.
  667. * everyheading:                          Custom Headings.
  668. * example:                               example.
  669. * exclamdown:                            Inserting Accents.
  670. * exdent:                                exdent.
  671. * file:                                  file.
  672. * filll:                                 Copyright & Permissions.
  673. * finalout:                              Overfull hboxes.
  674. * findex:                                Indexing Commands.
  675. * flushleft:                             flushleft & flushright.
  676. * flushright:                            flushleft & flushright.
  677. * foobar:                                Optional Arguments.
  678. * footnote:                              Footnotes.
  679. * footnotestyle:                         Footnote Styles.
  680. * format:                                format.
  681. * forward-word:                          Def Cmd Template.
  682. * ftable:                                ftable vtable.
  683. * group:                                 group.
  684. * H:                                     Inserting Accents.
  685. * heading:                               unnumberedsec appendixsec heading.
  686. * headings:                              headings on off.
  687. * html:                                  Raw Formatter Commands.
  688. * hyphenation:                           - and hyphenation.
  689. * i (italic font):                       Fonts.
  690. * ifclear:                               ifset ifclear.
  691. * ifhtml <1>:                            Raw Formatter Commands.
  692. * ifhtml:                                Conditional Commands.
  693. * ifinfo:                                Conditional Commands.
  694. * ifnothtml:                             Conditional Not Commands.
  695. * ifnotinfo:                             Conditional Not Commands.
  696. * ifnottex:                              Conditional Not Commands.
  697. * ifset:                                 ifset ifclear.
  698. * iftex:                                 Conditional Commands.
  699. * ignore:                                Comments.
  700. * image:                                 Images.
  701. * include:                               Using Include Files.
  702. * Info-validate:                         Running Info-Validate.
  703. * inforef:                               inforef.
  704. * input (TeX command):                   Minimum.
  705. * isearch-backward:                      deffnx.
  706. * isearch-forward:                       deffnx.
  707. * item <1>:                              Multitable Rows.
  708. * item <2>:                              table.
  709. * item:                                  itemize.
  710. * itemize:                               itemize.
  711. * itemx:                                 itemx.
  712. * kbd:                                   kbd.
  713. * kbdinputstyle:                         kbd.
  714. * key:                                   key.
  715. * kindex:                                Indexing Commands.
  716. * L:                                     Inserting Accents.
  717. * l:                                     Inserting Accents.
  718. * lisp:                                  Lisp Example.
  719. * lowersections:                         Raise/lower sections.
  720. * macro:                                 Defining Macros.
  721. * mag (TeX command):                     Cropmarks and Magnification.
  722. * majorheading:                          majorheading & chapheading.
  723. * makeinfo-buffer:                       makeinfo in Emacs.
  724. * makeinfo-kill-job:                     makeinfo in Emacs.
  725. * makeinfo-recenter-output-buffer:       makeinfo in Emacs.
  726. * makeinfo-region:                       makeinfo in Emacs.
  727. * math:                                  math.
  728. * menu:                                  Menus.
  729. * minus:                                 minus.
  730. * multitable:                            Multi-column Tables.
  731. * need:                                  need.
  732. * next-error:                            makeinfo in Emacs.
  733. * noindent:                              noindent.
  734. * O:                                     Inserting Accents.
  735. * o:                                     Inserting Accents.
  736. * occur:                                 Using occur.
  737. * occur-mode-goto-occurrence:            Showing the Structure.
  738. * oddfooting:                            Custom Headings.
  739. * oddheading:                            Custom Headings.
  740. * OE:                                    Inserting Accents.
  741. * oe:                                    Inserting Accents.
  742. * page:                                  page.
  743. * paragraphindent:                       paragraphindent.
  744. * pindex:                                Indexing Commands.
  745. * pounds:                                pounds.
  746. * printindex:                            Printing Indices & Menus.
  747. * pxref:                                 pxref.
  748. * questiondown:                          Inserting Accents.
  749. * quotation:                             quotation.
  750. * r (Roman font):                        Fonts.
  751. * raisesections:                         Raise/lower sections.
  752. * ref:                                   ref.
  753. * refill:                                Refilling Paragraphs.
  754. * ringaccent:                            Inserting Accents.
  755. * samp:                                  samp.
  756. * sc (small caps font):                  Smallcaps.
  757. * section:                               section.
  758. * set:                                   ifset ifclear.
  759. * setchapternewpage:                     setchapternewpage.
  760. * setfilename:                           setfilename.
  761. * settitle:                              settitle.
  762. * shortcontents:                         Contents.
  763. * shorttitlepage:                        titlepage.
  764. * smallbook:                             smallbook.
  765. * smallexample:                          smallexample & smalllisp.
  766. * smalllisp:                             smallexample & smalllisp.
  767. * sp (line spacing):                     sp.
  768. * sp (titlepage line spacing):           titlefont center sp.
  769. * ss:                                    Inserting Accents.
  770. * strong:                                emph & strong.
  771. * subheading:                            unnumberedsubsec appendixsubsec subheading.
  772. * subsection:                            subsection.
  773. * subsubheading:                         subsubsection.
  774. * subsubsection:                         subsubsection.
  775. * subtitle:                              title subtitle author.
  776. * summarycontents:                       Contents.
  777. * syncodeindex:                          syncodeindex.
  778. * synindex:                              synindex.
  779. * t (typewriter font):                   Fonts.
  780. * table:                                 Two-column Tables.
  781. * tex:                                   Raw Formatter Commands.
  782. * tex (command):                         tex.
  783. * texinfo-all-menus-update:              Updating Commands.
  784. * texinfo-every-node-update:             Updating Commands.
  785. * texinfo-format-buffer <1>:             texinfo-format commands.
  786. * texinfo-format-buffer:                 Info Formatting.
  787. * texinfo-format-region <1>:             texinfo-format commands.
  788. * texinfo-format-region:                 Info Formatting.
  789. * texinfo-indent-menu-description:       Other Updating Commands.
  790. * texinfo-insert-@code:                  Inserting.
  791. * texinfo-insert-@dfn:                   Inserting.
  792. * texinfo-insert-@end:                   Inserting.
  793. * texinfo-insert-@example:               Inserting.
  794. * texinfo-insert-@item:                  Inserting.
  795. * texinfo-insert-@kbd:                   Inserting.
  796. * texinfo-insert-@node:                  Inserting.
  797. * texinfo-insert-@noindent:              Inserting.
  798. * texinfo-insert-@samp:                  Inserting.
  799. * texinfo-insert-@table:                 Inserting.
  800. * texinfo-insert-@var:                   Inserting.
  801. * texinfo-insert-braces:                 Inserting.
  802. * texinfo-insert-node-lines:             Other Updating Commands.
  803. * texinfo-make-menu:                     Updating Commands.
  804. * texinfo-master-menu:                   Updating Commands.
  805. * texinfo-multiple-files-update:         texinfo-multiple-files-update.
  806. * texinfo-multiple-files-update (in brief): Other Updating Commands.
  807. * texinfo-sequential-node-update:        Other Updating Commands.
  808. * texinfo-show-structure <1>:            Using texinfo-show-structure.
  809. * texinfo-show-structure:                Showing the Structure.
  810. * texinfo-start-menu-description:        Inserting.
  811. * texinfo-tex-buffer:                    Printing.
  812. * texinfo-tex-print:                     Printing.
  813. * texinfo-tex-region:                    Printing.
  814. * texinfo-update-node:                   Updating Commands.
  815. * thischapter:                           Custom Headings.
  816. * thischaptername:                       Custom Headings.
  817. * thisfile:                              Custom Headings.
  818. * thispage:                              Custom Headings.
  819. * thistitle:                             Custom Headings.
  820. * tieaccent:                             Inserting Accents.
  821. * tindex:                                Indexing Commands.
  822. * title:                                 title subtitle author.
  823. * titlefont:                             titlefont center sp.
  824. * titlepage:                             titlepage.
  825. * today:                                 Custom Headings.
  826. * top (@-command):                       makeinfo top command.
  827. * u:                                     Inserting Accents.
  828. * ubaraccent:                            Inserting Accents.
  829. * udotaccent:                            Inserting Accents.
  830. * unmacro:                               Defining Macros.
  831. * unnumbered:                            unnumbered & appendix.
  832. * unnumberedsec:                         unnumberedsec appendixsec heading.
  833. * unnumberedsubsec:                      unnumberedsubsec appendixsubsec subheading.
  834. * unnumberedsubsubsec:                   subsubsection.
  835. * up-list:                               Inserting.
  836. * uref:                                  uref.
  837. * url:                                   url.
  838. * v:                                     Inserting Accents.
  839. * value:                                 value.
  840. * var:                                   var.
  841. * vindex:                                Indexing Commands.
  842. * vskip:                                 Copyright & Permissions.
  843. * vtable:                                ftable vtable.
  844. * w (prevent line break):                w.
  845. * xref:                                  xref.
  846. * { (single {):                          Inserting Braces.
  847. * } (single }):                          Inserting Braces.
  848. * ~:                                     Inserting Accents.
  849.  
  850.